Skip to main content
Version: 3.8

Home

The Home page showcases published API Packs for consumption. You can easily browse and select packs using the Category menu and sorting options. Choose a category from the sidebar to filter packs and adjust the display order as needed. The search feature allows you to find specific APIs by entering keywords, which matches pack names or descriptions closely.

home

Filter the API Pack by category selection​

  1. Click Categories icon.

categoriesicon

The side bar appears as shown below.

categoriesicon1

info

If required, use the search feature to quickly search for a category.

  1. Select the appropriate category by clicking the corresponding checkbox.

  2. Click Apply.

The API Packs in that category are displayed as shown below.

category_sidebar1

  1. Click Categories icon and click the Reset button to reset the filter.

category_sidebar2

Search by keyword(s)​

The Search functionality searches for keyword matches in API Pack names, API Plans and short and detailed descriptions to display results. It provides quick search results and word suggestions. Search results are ordered based on exact matches and closely related results.

info

You can search for a certain term or keyword(s).

  1. Enter keywords in the search box located at the top right corner.

search

  1. Click the keyboard's Enter button or click Search icon.

The search result that matches the keyword is displayed as shown below.

search1

  1. Click the Close icon to close the clear the search results.

Subscribe to a Plan​

You can subscribe to Plans under a Pack that contains the set of resources/operations you wish to use in your application. As an API subscriber, you may also select from several plans created by the Publisher user for the Pack based on their Throttling and Rate Limiting policies.

THAPIM offers three types of plans.

  1. Free Plan.
  2. Prepaid Plan
  3. Postpaid Plan.

Subscribe to a Free Plan​

  1. Click on the API Pack to which you wish to subscribe.

subscribeplan

The Plan page appears as shown below.

subscribeplan1

  1. Click Subscribe.
info

  • Click the View icon to view the Resources/operations available in the plan.

  • Click the Download icon to download the Resources/operations if necessary.

  • The screen below will vary depending on the Authentication Type selected at the Plan level (Subscription key, IP Whitelisting, Header Key, Query Parameter).

If Subscription key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Click Ok.
info

Click the Cancel button to terminate the subscription process.

Upon subscribing, the respective plan is updated as shown below.

If IP Whitelisting is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter IP value and click Add.

  2. Enter CIDR value and click Add.

  3. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

If Header Key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter Header Key and Header Value.

  2. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

If Query Parameter is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter the Query Parameter Key and Query Parameter Value.

  2. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

Subscribe to a Prepaid Plan​

  1. Click on the API Pack to which you wish to subscribe.

subscribeplan

The Plan page appears as shown below.

subscribeplanprepaid1

  1. Click Subscribe.
info

  • Click the View icon to view the Resources/operations available in the plan.

  • Click the Download icon to download the Resources/operations if necessary.

  • The screen below will vary depending on the Authentication Type selected at the Plan level (Subscription key, IP Whitelisting, Header Key, Query Parameter).

If Subscription key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Click Next.
info

Click the Cancel button to terminate the subscription process.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Pay.

On successful payment, the screen as shown below.

subscribeplanprepaid1

If IP Whitelisting is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter IP value and click Add.

  2. Enter CIDR value and click Add.

  3. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Pay.

On successful payment, the screen as shown below.

subscribeplanprepaid1

If Header Key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter Header Key and Header Value.

  2. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Pay.

On successful payment, the screen as shown below.

subscribeplanprepaid1

If Query Parameter is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter the Query Parameter Key and Query Parameter Value.

  2. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Pay.

On successful payment, the screen as shown below.

subscribeplanprepaid1

Subscribe to a Postpaid Plan​

  1. Click on the API Pack to which you wish to subscribe.

subscribeplan

The Plan page appears as shown below.

subscribeplanprepaid1

  1. Click Subscribe.
info

  • Click the View icon to view the Resources/operations available in the plan.

  • Click the Download icon to download the Resources/operations if necessary.

  • The screen below will vary depending on the Authentication Type selected at the Plan level (Subscription key, IP Whitelisting, Header Key, Query Parameter).

If Subscription key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Click Next.
info

Click the Cancel button to terminate the subscription process.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Subscribe.

On proceeding, the screen as shown below.

subscribeplanprepaid1

If IP Whitelisting is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter IP value and click Add.

  2. Enter CIDR value and click Add.

  3. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Subscribe.

On proceeding, the screen as shown below.

subscribeplanprepaid1

If Header Key is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter Header Key and Header Value.

  2. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Subscribe.

On proceeding, the screen as shown below.

subscribeplanprepaid1

If Query Parameter is selected as the Authentication Type.​

The pop-up appears as shown below.

  1. Enter the Query Parameter Key and Query Parameter Value.

  2. Click Next.

  1. Select the Privacy Type as either Black List or White List.(Optional).

  2. Enter the IP and Click Add.(Optional).

  3. Enter the CIDR and Click Add.(Optional).

  4. Click Ok.

  1. Select the Payment Gateway from the drop down.
info

THAPIM supports the following payment gateways:

  1. RazorPay
  2. Stripe

The screens shown below appear if Razorpay is used as the payment gateway:

The screens shown below appear if Stripe is used as the payment gateway:

a. Enter Email, Card information, Cardholder name and Billing address.

subscribeplanprepaid1

b. Click Subscribe.

On proceeding, the screen as shown below.

subscribeplanprepaid1

View API Pack Documentation​

The documentation for an API Pack guides you through several critical activities that will help you get started with the Pack. It offers thorough instructions for making API requests through your applications.

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

viewdocument

info

If the user opens the pack, the Plans page appears by default.

  1. Click Documentation tab.

The Documentation page appears as shown below.

viewdocument1

info

The documentation is displayed only if the publisher user includes it while creating the API pack.

View Sample Data​

The Sample Data tab provides code examples that can be used to create a sample API request. It also shows you the sample response you might expect when you submit the sample request.

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

viewsampledata

info

If the user opens the pack, the Plans page appears by default.

  1. Click Sample Data tab.

The Sample Data page appears as shown below.

viewsampledata1

info

The Sample Data is displayed only if the publisher user includes it while creating the API pack.

Use the Discussion Forum​

The API Pack Details page on the Developer portal includes built-in discussion forum support. An API Pack-specific discussion forum facilitates collaboration and community support for each API Pack. Both new and existing customers can benefit from communicating with other developers who share their interests.

caution

This is a common conversation forum. Please do not disclose any sensitive information.

Add New Discussion​

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

discussion

info

If the user opens the pack, the Plans page appears by default.

  1. Click Discussion tab.

The Discussion page appears as shown below.

discussion1

  1. Click Add Topic.

Add Topic dialog box appears as shown below.

  1. Select the Category from the drop down.

  2. Enter the Topic and Description.

  3. Click Add.

On adding a topic, the confirmation message appears as shown below.

discussion2

Manage Bookmark​

The Developer portal allows you to create new bookmarks and delete them from the home page.

Create a bookmark​

  1. Click the Bookmark icon located in the top right corner of the API Pack.

bookmark

The respective API pack is added to bookmark.

The Bookmark icon is updated and The confirmation message appears as shown below.

bookmark1

Remove a bookmark​

  1. Click the Bookmark icon in the lower right corner of the API Pack that has been bookmarked.

removebookmark

The screen appears as shown below.

  1. Click OK.

The respective API pack is removed from bookmark.

The Bookmark icon is updated and the confirmation message appears as shown below.

removebookmark1

Testing an API using Sandbox​

The Sandbox environment enables developers to test and understand how their applications integrate with APIs. It allows sample API calls directly from the documentation page, helping developers identify appropriate API plans by evaluating the number of APIs and consumption methods.

The Sandbox utilizes Swagger to describe the REST API service, including:

  • Resource name and description.
  • Methods and parameters (form/path/query) with required/optional indicators.
  • Expected response content types (JSON or XML).
  • HTTP response codes, error codes, and messages.

Sandbox Workflow​

Use the following checklist as a guide for utilizing the Sandbox environment:

  1. Create an Application Profile
  2. Generate Access Tokens
  3. Invoke APIs using the Try-it Feature
  4. Generate Client Code with SDK
  5. Develop and Integrate Apps with Sandbox Endpoints
  6. Perform Integration Tests with Sandbox Data
  7. Validate Token Expiry Scenarios and Simulate Errors

Invoking APIs Using the Try-it Feature​

  1. Click on the API Pack.

trysandbox

The screen appears as shown below.

trysandbox1

  1. Click Try it.

The Sandbox page appears as shown below.

trysandbox2

  1. Click the resource method to expand and display details.

trysandbox3

  1. Click Try it Out.

  2. Enter the required parameters in the mandatory fields and click Execute.

trysandbox4

info

The response message will display based on the input parameters.

trysandbox4

Important Considerations for Sandbox Testing​

While testing APIs in Sandbox, note the following limitations and behaviors:

  • The Try-it feature supports only REST resources configured via Swagger specification files.
  • Transaction details and analytics are not stored.
  • Auto-propagation to linked plans is not supported.
  • Plan-level security policies are not applicable.
  • Plans with OAuth security policies do not validate access tokens in Sandbox.
  • Rollback functionality is not supported.
  • Two-way SSL between the Portal and Nginx is not supported.
  • All backend service calls must implement URL encoding.

Character and Configuration Limitations​

  • IP Blacklisting, Whitelisting, and MCT limits are not applicable.
  • Unsupported URI Encoding Characters: # [ ] ~ | %
  • Supported Special Characters for Path and Query Parameters: `@ ! # $ % ^ & * - _ = + [] | : ; , . ``
  • Supported Special Characters for Resource Names: @ $ space ! * - _ = + . ,

Sandbox Restrictions​

  • Only one Sandbox Gateway is allowed per publisher account.
  • Sandbox plans support only subscription-key authentication.